<html>
<head>
<title>Docs For Class HTML_Progress</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">HTML_Progress</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ]
		  [ <a href="../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ]
		  [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: HTML_Progress</h1>
Source Location: /Progress.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description"></div><br /><br />







</td>



<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodHTML_Progress">HTML_Progress</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodaddListener">addListener</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodapiVersion">apiVersion</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methoddisplay">display</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetAnimSpeed">getAnimSpeed</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetDM">getDM</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetError">getError</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetIdent">getIdent</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetIncrement">getIncrement</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetListeners">getListeners</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetMaximum">getMaximum</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetMinimum">getMinimum</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetPercentComplete">getPercentComplete</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetScript">getScript</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetString">getString</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetStyle">getStyle</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetUI">getUI</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodgetValue">getValue</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodhasErrors">hasErrors</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodhide">hide</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodincValue">incValue</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodisBorderPainted">isBorderPainted</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodisIndeterminate">isIndeterminate</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodisStringPainted">isStringPainted</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodprocess">process</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodraiseError">raiseError</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodremoveListener">removeListener</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodrun">run</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetAnimSpeed">setAnimSpeed</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetBorderPainted">setBorderPainted</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetDM">setDM</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetIdent">setIdent</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetIncrement">setIncrement</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetIndeterminate">setIndeterminate</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetMaximum">setMaximum</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetMinimum">setMinimum</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetModel">setModel</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetProgressHandler">setProgressHandler</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetString">setString</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetStringPainted">setStringPainted</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetUI">setUI</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsetValue">setValue</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodsleep">sleep</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodtoArray">toArray</a></li>
    <li><a href="../HTML_Progress/HTML_Progress.html#methodtoHtml">toHtml</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>






</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 207]<br />
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />


<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
  <hr />
	<a name="methodHTML_Progress"></a>
	<h3>constructor HTML_Progress <span class="smalllinenumber">[line 382]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>HTML_Progress HTML_Progress(
object
$model, int
$orient, int
$min, int
$max, array
$errorPrefs)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Constructor Summary<br /><br /><p><ul><li>Creates a natural horizontal progress bar that displays ten cells/units
   with no border and no progress string.
   The initial and minimum values are 0, and the maximum is 100.
   <div class="listing"><pre><ol><li>   <span class="src-var">$bar </span>= <span class="src-key">new </span><a href="../HTML_Progress/HTML_Progress.html#methodHTML_Progress">HTML_Progress</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul> <ul><li>Creates a natural progress bar with the specified orientation, which can be
   either HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL
   By default, no border and no progress string are painted.
   The initial and minimum values are 0, and the maximum is 100.
   <div class="listing"><pre><ol><li>   <span class="src-var">$bar </span>= <span class="src-key">new </span><a href="../HTML_Progress/HTML_Progress.html#methodHTML_Progress">HTML_Progress</a><span class="src-sym">(</span><span class="src-var">$orient</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul> <ul><li>Creates a natural horizontal progress bar with the specified minimum and
   maximum. Sets the initial value of the progress bar to the specified
   minimum, and the maximum that the progress bar can reach.
   By default, no border and no progress string are painted.
   <div class="listing"><pre><ol><li>   <span class="src-var">$bar </span>= <span class="src-key">new </span><a href="../HTML_Progress/HTML_Progress.html#methodHTML_Progress">HTML_Progress</a><span class="src-sym">(</span><span class="src-var">$min</span><span class="src-sym">, </span><span class="src-var">$max</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul> <ul><li>Creates a natural horizontal progress bar with the specified orientation,
   minimum and maximum. Sets the initial value of the progress bar to the
   specified minimum, and the maximum that the progress bar can reach.
   By default, no border and no progress string are painted.
   <div class="listing"><pre><ol><li>   <span class="src-var">$bar </span>= <span class="src-key">new </span><a href="../HTML_Progress/HTML_Progress.html#methodHTML_Progress">HTML_Progress</a><span class="src-sym">(</span><span class="src-var">$orient</span><span class="src-sym">, </span><span class="src-var">$min</span><span class="src-sym">, </span><span class="src-var">$max</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul> <ul><li>Creates a natural horizontal progress that uses the specified model
   to hold the progress bar's data.
   By default, no border and no progress string are painted.
   <div class="listing"><pre><ol><li>   <span class="src-var">$bar </span>= <span class="src-key">new </span><a href="../HTML_Progress/HTML_Progress.html#methodHTML_Progress">HTML_Progress</a><span class="src-sym">(</span><span class="src-var">$model</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetIndeterminate">HTML_Progress::setIndeterminate()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetBorderPainted">HTML_Progress::setBorderPainted()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetStringPainted">HTML_Progress::setStringPainted()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetString">HTML_Progress::setString()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetDM">HTML_Progress::setDM()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetUI">HTML_Progress::setUI()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetIdent">HTML_Progress::setIdent()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$model</b>&nbsp;&nbsp;</td>
        <td>(optional) Model that hold the progress bar's data</td>
      </tr>
          <tr>
        <td class="type">int&nbsp;&nbsp;</td>
        <td><b>$orient</b>&nbsp;&nbsp;</td>
        <td>(optional) Orientation of progress bar</td>
      </tr>
          <tr>
        <td class="type">int&nbsp;&nbsp;</td>
        <td><b>$min</b>&nbsp;&nbsp;</td>
        <td>(optional) Minimum value of progress bar</td>
      </tr>
          <tr>
        <td class="type">int&nbsp;&nbsp;</td>
        <td><b>$max</b>&nbsp;&nbsp;</td>
        <td>(optional) Maximum value of progress bar</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$errorPrefs</b>&nbsp;&nbsp;</td>
        <td>(optional) Always last argument of class constructor.                                        hash of params to configure PEAR_ErrorStack and loggers</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodaddListener"></a>
	<h3>method addListener <span class="smalllinenumber">[line 1503]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean addListener(
object
$observer)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Adds a HTML_Progress_Observer instance to the list of observers  that are listening for messages emitted by this HTML_Progress instance.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>True if the observer is successfully attached.</td>
  </tr>
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.addlistener.pkg.html">HTML_Progress::addListener</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetListeners">HTML_Progress::getListeners()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodremoveListener">HTML_Progress::removeListener()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$observer</b>&nbsp;&nbsp;</td>
        <td>The HTML_Progress_Observer instance                                       to attach as a listener.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodapiVersion"></a>
	<h3>method apiVersion <span class="smalllinenumber">[line 491]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>float apiVersion(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the current API version<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>0.1</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddisplay"></a>
	<h3>method display <span class="smalllinenumber">[line 1291]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void display(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Renders the new value of progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>0.2</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetAnimSpeed"></a>
	<h3>method getAnimSpeed <span class="smalllinenumber">[line 1055]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getAnimSpeed(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns delay execution of the progress bar<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.getanimspeed.pkg.html">HTML_Progress::getAnimSpeed</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetAnimSpeed">HTML_Progress::setAnimSpeed()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC1</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetDM"></a>
	<h3>method getDM <span class="smalllinenumber">[line 669]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>object &amp;getDM(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the data model used by this progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetDM">HTML_Progress::setDM()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetError"></a>
	<h3>method getError <span class="smalllinenumber">[line 2250]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>false|array getError(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Pop an error off of the HTML_Progress stack<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodhasErrors">HTML_Progress::hasErrors()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodraiseError">HTML_Progress::raiseError()</a></td>
  </tr>
  <tr>
    <td><b>static:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC3</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetIdent"></a>
	<h3>method getIdent <span class="smalllinenumber">[line 1453]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string getIdent(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the current identification string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>current Progress instance's identification string</td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetIdent">HTML_Progress::setIdent()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetIncrement"></a>
	<h3>method getIncrement <span class="smalllinenumber">[line 800]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getIncrement(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the progress bar's increment value stored in the progress bar's data model.<br /><br /><p>The default value is +1.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.getincrement.pkg.html">HTML_Progress::getIncrement</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetIncrement">HTML_Progress::setIncrement()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetIncrement">HTML_Progress_DM::getIncrement()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetListeners"></a>
	<h3>method getListeners <span class="smalllinenumber">[line 1485]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array getListeners(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns an array of all the listeners added to this progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.getlisteners.pkg.html">HTML_Progress::getListeners</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodaddListener">HTML_Progress::addListener()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodremoveListener">HTML_Progress::removeListener()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetMaximum"></a>
	<h3>method getMaximum <span class="smalllinenumber">[line 759]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getMaximum(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the progress bar's maximum value stored in the progress bar's data model.<br /><br /><p>The default value is 100.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.getmaximum.pkg.html">HTML_Progress::getMaximum</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetMaximum">HTML_Progress::setMaximum()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetMaximum">HTML_Progress_DM::getMaximum()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetMinimum"></a>
	<h3>method getMinimum <span class="smalllinenumber">[line 718]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getMinimum(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the progress bar's minimum value stored in the progress bar's data model.<br /><br /><p>The default value is 0.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.getminimum.pkg.html">HTML_Progress::getMinimum</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetMinimum">HTML_Progress::setMinimum()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetMinimum">HTML_Progress_DM::getMinimum()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetPercentComplete"></a>
	<h3>method getPercentComplete <span class="smalllinenumber">[line 893]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>float getPercentComplete(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the percent complete for the progress bar. Note that this number is  between 0.00 and 1.00.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.getpercentcomplete.pkg.html">HTML_Progress::getPercentComplete</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetValue">HTML_Progress::getValue()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodgetMaximum">HTML_Progress::getMaximum()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetPercentComplete">HTML_Progress_DM::getPercentComplete()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetScript"></a>
	<h3>method getScript <span class="smalllinenumber">[line 1128]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string getScript(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Get the javascript code to manage progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>JavaScript URL or inline code to manage progress bar</td>
  </tr>
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_ui.getscript.pkg.html">HTML_Progress_UI::getScript</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetScript">HTML_Progress_UI::getScript()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetString"></a>
	<h3>method getString <span class="smalllinenumber">[line 632]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string getString(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the current value of the progress string.<br /><br /><p>By default, the progress bar displays the value returned by  getPercentComplete() method formatted as a percent such as 33%.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.getstring.pkg.html">HTML_Progress::getString</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetString">HTML_Progress::setString()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodisStringPainted">HTML_Progress::isStringPainted()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetStyle"></a>
	<h3>method getStyle <span class="smalllinenumber">[line 1107]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string getStyle(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Get the cascading style sheet to put inline on HTML document<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_ui.getstyle.pkg.html">HTML_Progress_UI::getStyle</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStyle">HTML_Progress_UI::getStyle()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetUI"></a>
	<h3>method getUI <span class="smalllinenumber">[line 906]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>object &amp;getUI(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the look-and-feel object that renders the progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetUI">HTML_Progress::setUI()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetValue"></a>
	<h3>method getValue <span class="smalllinenumber">[line 835]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getValue(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the progress bar's current value, which is stored in the  progress bar's data model. The value is always between the minimum  and maximum values, inclusive.<br /><br /><p>By default, the value is initialized to be equal to the minimum value.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.getvalue.pkg.html">HTML_Progress::getValue</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetValue">HTML_Progress::setValue()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodincValue">HTML_Progress::incValue()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodgetValue">HTML_Progress_DM::getValue()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodhasErrors"></a>
	<h3>method hasErrors <span class="smalllinenumber">[line 2236]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer hasErrors(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Determine whether there are errors into the HTML_Progress stack<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetError">HTML_Progress::getError()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodraiseError">HTML_Progress::raiseError()</a></td>
  </tr>
  <tr>
    <td><b>static:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC3</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodhide"></a>
	<h3>method hide <span class="smalllinenumber">[line 1337]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void hide(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Hides the progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC3</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodincValue"></a>
	<h3>method incValue <span class="smalllinenumber">[line 876]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void incValue(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Updates the progress bar's current value by adding increment value.<br /><br /><p>All change listeners are notified.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.incvalue.pkg.html">HTML_Progress::incValue</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetValue">HTML_Progress::getValue()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetValue">HTML_Progress::setValue()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodincValue">HTML_Progress_DM::incValue()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodisBorderPainted"></a>
	<h3>method isBorderPainted <span class="smalllinenumber">[line 548]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean isBorderPainted(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Determines whether the progress bar border is painted or not.<br /><br /><p>The default is false.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.isborderpainted.pkg.html">HTML_Progress::isBorderPainted</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetBorderPainted">HTML_Progress::setBorderPainted()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodisIndeterminate"></a>
	<h3>method isIndeterminate <span class="smalllinenumber">[line 505]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean isIndeterminate(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns mode of the progress bar (determinate or not).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.isindeterminate.pkg.html">HTML_Progress::isIndeterminate</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetIndeterminate">HTML_Progress::setIndeterminate()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodisStringPainted"></a>
	<h3>method isStringPainted <span class="smalllinenumber">[line 591]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean isStringPainted(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Determines whether the progress bar string is painted or not.<br /><br /><p>The default is false.  The progress bar displays the value returned by getPercentComplete() method  formatted as a percent such as 33%.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.isstringpainted.pkg.html">HTML_Progress::isStringPainted</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetStringPainted">HTML_Progress::setStringPainted()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetString">HTML_Progress::setString()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodprocess"></a>
	<h3>method process <span class="smalllinenumber">[line 1409]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void process(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Performs the progress actions<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsleep">HTML_Progress::sleep()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC3</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodraiseError"></a>
	<h3>method raiseError <span class="smalllinenumber">[line 2167]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>NULL|PEAR_Error raiseError(
integer
$code, string
$level, array
$params)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Add an error to the stack<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>PEAR_Error instance,                                    with context info if PHP 4.3.0+</td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodhasErrors">HTML_Progress::hasErrors()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodgetError">HTML_Progress::getError()</a></td>
  </tr>
  <tr>
    <td><b>static:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$code</b>&nbsp;&nbsp;</td>
        <td>Error code.</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$level</b>&nbsp;&nbsp;</td>
        <td>The error level of the message.</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$params</b>&nbsp;&nbsp;</td>
        <td>Associative array of error parameters</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodremoveListener"></a>
	<h3>method removeListener <span class="smalllinenumber">[line 1525]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>boolean removeListener(
object
$observer)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Removes a HTML_Progress_Observer instance from the list of observers.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>True if the observer is successfully detached.</td>
  </tr>
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.removelistener.pkg.html">HTML_Progress::removeListener</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetListeners">HTML_Progress::getListeners()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodaddListener">HTML_Progress::addListener()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$observer</b>&nbsp;&nbsp;</td>
        <td>The HTML_Progress_Observer instance                                       to detach from the list of listeners.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodrun"></a>
	<h3>method run <span class="smalllinenumber">[line 1429]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void run(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Runs the progress bar (both modes: indeterminate and determinate),  and execute all actions defined in user callback identified by  method setProgressHandler.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodprocess">HTML_Progress::process()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetProgressHandler">HTML_Progress::setProgressHandler()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC3</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetAnimSpeed"></a>
	<h3>method setAnimSpeed <span class="smalllinenumber">[line 1072]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setAnimSpeed(
integer
$delay)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Set the delays progress bar execution for the given number of miliseconds.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.setanimspeed.pkg.html">HTML_Progress::setAnimSpeed</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetAnimSpeed">HTML_Progress::getAnimSpeed()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$delay</b>&nbsp;&nbsp;</td>
        <td>Delay in milisecond.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetBorderPainted"></a>
	<h3>method setBorderPainted <span class="smalllinenumber">[line 566]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setBorderPainted(
boolean
$paint)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the value of $_paintBorder property, which determines whether the  progress bar should paint its border. The default is false.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.setborderpainted.pkg.html">HTML_Progress::setBorderPainted</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodisBorderPainted">HTML_Progress::isBorderPainted()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">boolean&nbsp;&nbsp;</td>
        <td><b>$paint</b>&nbsp;&nbsp;</td>
        <td>whether the progress bar should paint its border</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetDM"></a>
	<h3>method setDM <span class="smalllinenumber">[line 685]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setDM(
string
$model)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the data model used by this progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetDM">HTML_Progress::getDM()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$model</b>&nbsp;&nbsp;</td>
        <td>class name of a html_progress_dm extends object</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetIdent"></a>
	<h3>method setIdent <span class="smalllinenumber">[line 1467]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setIdent(
[mixed
$ident = null])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets this Progress instance's identification string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetIdent">HTML_Progress::getIdent()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$ident</b>&nbsp;&nbsp;</td>
        <td>(optional) the new identification string.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetIncrement"></a>
	<h3>method setIncrement <span class="smalllinenumber">[line 817]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setIncrement(
integer
$inc)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the progress bar's increment value stored in the progress bar's data model.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.setincrement.pkg.html">HTML_Progress::setIncrement</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetIncrement">HTML_Progress::getIncrement()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodsetIncrement">HTML_Progress_DM::setIncrement()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$inc</b>&nbsp;&nbsp;</td>
        <td>progress bar's increment value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetIndeterminate"></a>
	<h3>method setIndeterminate <span class="smalllinenumber">[line 526]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setIndeterminate(
boolean
$continuous)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the $_indeterminate property of the progress bar, which determines  whether the progress bar is in determinate or indeterminate mode.<br /><br /><p>An indeterminate progress bar continuously displays animation indicating  that an operation of unknown length is occuring.  By default, this property is false.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.setindeterminate.pkg.html">HTML_Progress::setIndeterminate</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodisIndeterminate">HTML_Progress::isIndeterminate()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">boolean&nbsp;&nbsp;</td>
        <td><b>$continuous</b>&nbsp;&nbsp;</td>
        <td>whether countinuously displays animation</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetMaximum"></a>
	<h3>method setMaximum <span class="smalllinenumber">[line 778]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setMaximum(
integer
$max)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the progress bar's maximum value stored in the progress bar's data model.<br /><br /><p>If the maximum value is different from previous maximum, all change listeners  are notified.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.setmaximum.pkg.html">HTML_Progress::setMaximum</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetMaximum">HTML_Progress::getMaximum()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodsetMaximum">HTML_Progress_DM::setMaximum()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$max</b>&nbsp;&nbsp;</td>
        <td>progress bar's maximal value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetMinimum"></a>
	<h3>method setMinimum <span class="smalllinenumber">[line 737]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setMinimum(
integer
$min)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the progress bar's minimum value stored in the progress bar's data model.<br /><br /><p>If the minimum value is different from previous minimum, all change listeners  are notified.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.setminimum.pkg.html">HTML_Progress::setMinimum</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetMinimum">HTML_Progress::getMinimum()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodsetMinimum">HTML_Progress_DM::setMinimum()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$min</b>&nbsp;&nbsp;</td>
        <td>progress bar's minimal value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetModel"></a>
	<h3>method setModel <span class="smalllinenumber">[line 957]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setModel(
string
$file, string
$type)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the look-and-feel model that renders the progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.setmodel.pkg.html">HTML_Progress::setModel</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodsetUI">HTML_Progress::setUI()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$file</b>&nbsp;&nbsp;</td>
        <td>file name of model properties</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$type</b>&nbsp;&nbsp;</td>
        <td>type of external ressource (phpArray, iniFile, XML ...)</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetProgressHandler"></a>
	<h3>method setProgressHandler <span class="smalllinenumber">[line 1389]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setProgressHandler(
mixed
$handler)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the user callback function that execute all actions pending progress<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodprocess">HTML_Progress::process()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_CALLBACK</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC3</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$handler</b>&nbsp;&nbsp;</td>
        <td>Name of function or a class-method.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetString"></a>
	<h3>method setString <span class="smalllinenumber">[line 656]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setString(
string
$str)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the current value of the progress string. By default, this string  is null. If you have provided a custom progress string and want to revert  to the built-in-behavior, set the string back to null.<br /><br /><p>The progress string is painted only if the isStringPainted() method  returns true.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.setstring.pkg.html">HTML_Progress::setString</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetString">HTML_Progress::getString()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodisStringPainted">HTML_Progress::isStringPainted()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetStringPainted">HTML_Progress::setStringPainted()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$str</b>&nbsp;&nbsp;</td>
        <td>progress string</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetStringPainted"></a>
	<h3>method setStringPainted <span class="smalllinenumber">[line 609]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setStringPainted(
boolean
$paint)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the value of $_paintString property, which determines whether the  progress bar should render a progress string. The default is false.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_progress.setstringpainted.pkg.html">HTML_Progress::setStringPainted</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodisStringPainted">HTML_Progress::isStringPainted()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetString">HTML_Progress::setString()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">boolean&nbsp;&nbsp;</td>
        <td><b>$paint</b>&nbsp;&nbsp;</td>
        <td>whether the progress bar should render a string</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetUI"></a>
	<h3>method setUI <span class="smalllinenumber">[line 922]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setUI(
string
$ui)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the look-and-feel object that renders the progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetUI">HTML_Progress::getUI()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$ui</b>&nbsp;&nbsp;</td>
        <td>class name of a html_progress_ui extends object</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetValue"></a>
	<h3>method setValue <span class="smalllinenumber">[line 854]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setValue(
integer
$val)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the progress bar's current value stored in the progress bar's data model.<br /><br /><p>If the new value is different from previous value, all change listeners  are notified.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/tutorial_dm.setvalue.pkg.html">HTML_Progress::setValue</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetValue">HTML_Progress::getValue()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodincValue">HTML_Progress::incValue()</a>, <a href="../HTML_Progress/Progress_DM/HTML_Progress_DM.html#methodsetValue">HTML_Progress_DM::setValue()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$val</b>&nbsp;&nbsp;</td>
        <td>progress bar's current value</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsleep"></a>
	<h3>method sleep <span class="smalllinenumber">[line 1366]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void sleep(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Default user callback when none are defined.<br /><br /><p>Delay execution of progress meter for the given number of milliseconds.</p><p>NOTE: The function <a href="http://www.php.net/manual/en/function.usleep.php">http://www.php.net/manual/en/function.usleep.php</a>        did not work on Windows systems until PHP 5.0.0</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../HTML_Progress/HTML_Progress.html#methodgetAnimSpeed">HTML_Progress::getAnimSpeed()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodsetAnimSpeed">HTML_Progress::setAnimSpeed()</a>, <a href="../HTML_Progress/HTML_Progress.html#methodprocess">HTML_Progress::process()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC3</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodtoArray"></a>
	<h3>method toArray <span class="smalllinenumber">[line 1142]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array toArray(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the progress bar structure in an array.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>of progress bar properties</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodtoHtml"></a>
	<h3>method toHtml <span class="smalllinenumber">[line 1180]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string toHtml(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the progress structure as HTML.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>HTML Progress bar</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>0.2</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 12 Sep 2004 20:23:42 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>